feat: Link the CRD reference on the Stackable Hub#888
Conversation
✅ Deploy Preview for stackable-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
The docs' own pages now link https://hub.stackable.tech/crds instead of the old CRD browser on crds.stackable.tech, using the new attributes: crd-ref: the listing {crd-ref}/<group>/<apiVersion>/<kind>{crd-ref-release}: a deep link crd-ref-release is ?release=dev on this branch and gets the release number on release branches (like crd-docs-version today). The old crd-docs attributes stay until the operator repos migrate their deep links to crd-ref (they do so in the planned operator sweep, one PR per repo). page-crd-docs is removed: nothing in the UI templates reads it. The OIDC provider deep link loses its per-property anchor: the Hub has section-level anchors only, so it points at #provider now.
3e4086e to
b9dc3c4
Compare
There was a problem hiding this comment.
Not in the changed files, so adding it here: https://github.com/stackabletech/documentation/blob/main/scripts/make-release-branch.sh#L121 also would need updating with the new value for the version
|
And just as a side note: The changes need to be backported to the older branches, otherwise the CRD links there would still point to the old url and not have the new values in |
make-release-branch.sh already rewrites version, prerelease and crd-docs-version; without this, a release branch would keep ?release=dev and its Hub CRD links would show bleeding-edge schemas. The Hub names releases by major.minor, so this uses DOCS_VERSION (e.g. 26.7), not VERSION (e.g. 26.7.1); the Hub 301s patch-level values but major.minor is canonical.
Same kind of reminder comment that crd-docs-version has, in case the attribute is ever edited by hand instead of via the release script.
On backporting: Thanks... I always get confused by this, but you're right. This PR only covers a few "generic" links so that should actually be mostly fine but the "real links" are in each operator repo....so having to backport all of those to multiple branches will be painful. I'll see what I can do - I hope that maybe we can use some clever redirects instead. |
lfrancke
moved this from Development: Waiting for Review
to Development: Done
in Stackable Engineering
2 participants
Description
Our Hub now uses a similar URL style to the old CRD browser which means we can switch the docs to use the Hub instead of the old one.
To help with that there are new attributes in
antora.yml:crd-ref- the listing (https://hub.stackable.tech/crds){crd-ref}/<group>/<apiVersion>/<kind>{crd-ref-release}- a deep linkcrd-ref-release-?release=devon main, the release number on release branches (same mechanism ascrd-docs-versiontoday)Converted: the reference nav entry, the landing page link, and the five deep links (AuthenticationClass ×3, S3Bucket, S3Connection).
Deliberately unchanged
crd-docs-*attributes stay: the operator repos still build their deep links from them (~40 links). We need to update those separately :( (I'll do it...)page-crd-docsis removed - nothing in the UI templates reads it.